<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="tagmanager_v2.html">Tag Manager API</a> . <a href="tagmanager_v2.accounts.html">accounts</a> . <a href="tagmanager_v2.accounts.containers.html">containers</a> . <a href="tagmanager_v2.accounts.containers.workspaces.html">workspaces</a> . <a href="tagmanager_v2.accounts.containers.workspaces.built_in_variables.html">built_in_variables</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates one or more GTM Built-In Variables.</p>
<p class="toc_element">
  <code><a href="#delete">delete(path, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes one or more GTM Built-In Variables.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the enabled Built-In Variables of a GTM Container.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#revert">revert(path, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reverts changes to a GTM Built-In Variables in a GTM Workspace.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, type=None, x__xgafv=None)</code>
  <pre>Creates one or more GTM Built-In Variables.

Args:
  parent: string, GTM Workspace&#x27;s API relative path. (required)
  type: string, The types of built-in variables to enable. (repeated)
    Allowed values
      builtInVariableTypeUnspecified - 
      pageUrl - 
      pageHostname - 
      pagePath - 
      referrer - 
      event - For web or mobile.
      clickElement - 
      clickClasses - 
      clickId - 
      clickTarget - 
      clickUrl - 
      clickText - 
      firstPartyServingUrl - 
      formElement - 
      formClasses - 
      formId - 
      formTarget - 
      formUrl - 
      formText - 
      errorMessage - 
      errorUrl - 
      errorLine - 
      newHistoryUrl - 
      oldHistoryUrl - 
      newHistoryFragment - 
      oldHistoryFragment - 
      newHistoryState - 
      oldHistoryState - 
      historySource - 
      containerVersion - For web or mobile.
      debugMode - 
      randomNumber - For web or mobile.
      containerId - For web or mobile.
      appId - 
      appName - 
      appVersionCode - 
      appVersionName - 
      language - 
      osVersion - 
      platform - 
      sdkVersion - 
      deviceName - 
      resolution - 
      advertiserId - 
      advertisingTrackingEnabled - 
      htmlId - 
      environmentName - 
      ampBrowserLanguage - 
      ampCanonicalPath - 
      ampCanonicalUrl - 
      ampCanonicalHost - 
      ampReferrer - 
      ampTitle - 
      ampClientId - 
      ampClientTimezone - 
      ampClientTimestamp - 
      ampClientScreenWidth - 
      ampClientScreenHeight - 
      ampClientScrollX - 
      ampClientScrollY - 
      ampClientMaxScrollX - 
      ampClientMaxScrollY - 
      ampTotalEngagedTime - 
      ampPageViewId - 
      ampPageLoadTime - 
      ampPageDownloadTime - 
      ampGtmEvent - 
      eventName - 
      firebaseEventParameterCampaign - 
      firebaseEventParameterCampaignAclid - 
      firebaseEventParameterCampaignAnid - 
      firebaseEventParameterCampaignClickTimestamp - 
      firebaseEventParameterCampaignContent - 
      firebaseEventParameterCampaignCp1 - 
      firebaseEventParameterCampaignGclid - 
      firebaseEventParameterCampaignSource - 
      firebaseEventParameterCampaignTerm - 
      firebaseEventParameterCurrency - 
      firebaseEventParameterDynamicLinkAcceptTime - 
      firebaseEventParameterDynamicLinkLinkid - 
      firebaseEventParameterNotificationMessageDeviceTime - 
      firebaseEventParameterNotificationMessageId - 
      firebaseEventParameterNotificationMessageName - 
      firebaseEventParameterNotificationMessageTime - 
      firebaseEventParameterNotificationTopic - 
      firebaseEventParameterPreviousAppVersion - 
      firebaseEventParameterPreviousOsVersion - 
      firebaseEventParameterPrice - 
      firebaseEventParameterProductId - 
      firebaseEventParameterQuantity - 
      firebaseEventParameterValue - 
      videoProvider - 
      videoUrl - 
      videoTitle - 
      videoDuration - 
      videoPercent - 
      videoVisible - 
      videoStatus - 
      videoCurrentTime - 
      scrollDepthThreshold - 
      scrollDepthUnits - 
      scrollDepthDirection - 
      elementVisibilityRatio - 
      elementVisibilityTime - 
      elementVisibilityFirstTime - 
      elementVisibilityRecentTime - 
      requestPath - 
      requestMethod - 
      clientName - 
      queryString - 
      serverPageLocationUrl - 
      serverPageLocationPath - 
      serverPageLocationHostname - 
      visitorRegion - 
      analyticsClientId - 
      analyticsSessionId - 
      analyticsSessionNumber - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;builtInVariable&quot;: [ # List of created built-in variables.
    { # Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.
      &quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
      &quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
      &quot;name&quot;: &quot;A String&quot;, # Name of the built-in variable to be used to refer to the built-in variable.
      &quot;path&quot;: &quot;A String&quot;, # GTM BuiltInVariable&#x27;s API relative path.
      &quot;type&quot;: &quot;A String&quot;, # Type of built-in variable.
      &quot;workspaceId&quot;: &quot;A String&quot;, # GTM Workspace ID.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(path, type=None, x__xgafv=None)</code>
  <pre>Deletes one or more GTM Built-In Variables.

Args:
  path: string, GTM BuiltInVariable&#x27;s API relative path. (required)
  type: string, The types of built-in variables to delete. (repeated)
    Allowed values
      builtInVariableTypeUnspecified - 
      pageUrl - 
      pageHostname - 
      pagePath - 
      referrer - 
      event - For web or mobile.
      clickElement - 
      clickClasses - 
      clickId - 
      clickTarget - 
      clickUrl - 
      clickText - 
      firstPartyServingUrl - 
      formElement - 
      formClasses - 
      formId - 
      formTarget - 
      formUrl - 
      formText - 
      errorMessage - 
      errorUrl - 
      errorLine - 
      newHistoryUrl - 
      oldHistoryUrl - 
      newHistoryFragment - 
      oldHistoryFragment - 
      newHistoryState - 
      oldHistoryState - 
      historySource - 
      containerVersion - For web or mobile.
      debugMode - 
      randomNumber - For web or mobile.
      containerId - For web or mobile.
      appId - 
      appName - 
      appVersionCode - 
      appVersionName - 
      language - 
      osVersion - 
      platform - 
      sdkVersion - 
      deviceName - 
      resolution - 
      advertiserId - 
      advertisingTrackingEnabled - 
      htmlId - 
      environmentName - 
      ampBrowserLanguage - 
      ampCanonicalPath - 
      ampCanonicalUrl - 
      ampCanonicalHost - 
      ampReferrer - 
      ampTitle - 
      ampClientId - 
      ampClientTimezone - 
      ampClientTimestamp - 
      ampClientScreenWidth - 
      ampClientScreenHeight - 
      ampClientScrollX - 
      ampClientScrollY - 
      ampClientMaxScrollX - 
      ampClientMaxScrollY - 
      ampTotalEngagedTime - 
      ampPageViewId - 
      ampPageLoadTime - 
      ampPageDownloadTime - 
      ampGtmEvent - 
      eventName - 
      firebaseEventParameterCampaign - 
      firebaseEventParameterCampaignAclid - 
      firebaseEventParameterCampaignAnid - 
      firebaseEventParameterCampaignClickTimestamp - 
      firebaseEventParameterCampaignContent - 
      firebaseEventParameterCampaignCp1 - 
      firebaseEventParameterCampaignGclid - 
      firebaseEventParameterCampaignSource - 
      firebaseEventParameterCampaignTerm - 
      firebaseEventParameterCurrency - 
      firebaseEventParameterDynamicLinkAcceptTime - 
      firebaseEventParameterDynamicLinkLinkid - 
      firebaseEventParameterNotificationMessageDeviceTime - 
      firebaseEventParameterNotificationMessageId - 
      firebaseEventParameterNotificationMessageName - 
      firebaseEventParameterNotificationMessageTime - 
      firebaseEventParameterNotificationTopic - 
      firebaseEventParameterPreviousAppVersion - 
      firebaseEventParameterPreviousOsVersion - 
      firebaseEventParameterPrice - 
      firebaseEventParameterProductId - 
      firebaseEventParameterQuantity - 
      firebaseEventParameterValue - 
      videoProvider - 
      videoUrl - 
      videoTitle - 
      videoDuration - 
      videoPercent - 
      videoVisible - 
      videoStatus - 
      videoCurrentTime - 
      scrollDepthThreshold - 
      scrollDepthUnits - 
      scrollDepthDirection - 
      elementVisibilityRatio - 
      elementVisibilityTime - 
      elementVisibilityFirstTime - 
      elementVisibilityRecentTime - 
      requestPath - 
      requestMethod - 
      clientName - 
      queryString - 
      serverPageLocationUrl - 
      serverPageLocationPath - 
      serverPageLocationHostname - 
      visitorRegion - 
      analyticsClientId - 
      analyticsSessionId - 
      analyticsSessionNumber - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the enabled Built-In Variables of a GTM Container.

Args:
  parent: string, GTM Workspace&#x27;s API relative path. (required)
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A list of enabled built-in variables.
  &quot;builtInVariable&quot;: [ # All GTM BuiltInVariables of a GTM container.
    { # Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.
      &quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
      &quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
      &quot;name&quot;: &quot;A String&quot;, # Name of the built-in variable to be used to refer to the built-in variable.
      &quot;path&quot;: &quot;A String&quot;, # GTM BuiltInVariable&#x27;s API relative path.
      &quot;type&quot;: &quot;A String&quot;, # Type of built-in variable.
      &quot;workspaceId&quot;: &quot;A String&quot;, # GTM Workspace ID.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="revert">revert(path, type=None, x__xgafv=None)</code>
  <pre>Reverts changes to a GTM Built-In Variables in a GTM Workspace.

Args:
  path: string, GTM BuiltInVariable&#x27;s API relative path. (required)
  type: string, The type of built-in variable to revert.
    Allowed values
      builtInVariableTypeUnspecified - 
      pageUrl - 
      pageHostname - 
      pagePath - 
      referrer - 
      event - For web or mobile.
      clickElement - 
      clickClasses - 
      clickId - 
      clickTarget - 
      clickUrl - 
      clickText - 
      firstPartyServingUrl - 
      formElement - 
      formClasses - 
      formId - 
      formTarget - 
      formUrl - 
      formText - 
      errorMessage - 
      errorUrl - 
      errorLine - 
      newHistoryUrl - 
      oldHistoryUrl - 
      newHistoryFragment - 
      oldHistoryFragment - 
      newHistoryState - 
      oldHistoryState - 
      historySource - 
      containerVersion - For web or mobile.
      debugMode - 
      randomNumber - For web or mobile.
      containerId - For web or mobile.
      appId - 
      appName - 
      appVersionCode - 
      appVersionName - 
      language - 
      osVersion - 
      platform - 
      sdkVersion - 
      deviceName - 
      resolution - 
      advertiserId - 
      advertisingTrackingEnabled - 
      htmlId - 
      environmentName - 
      ampBrowserLanguage - 
      ampCanonicalPath - 
      ampCanonicalUrl - 
      ampCanonicalHost - 
      ampReferrer - 
      ampTitle - 
      ampClientId - 
      ampClientTimezone - 
      ampClientTimestamp - 
      ampClientScreenWidth - 
      ampClientScreenHeight - 
      ampClientScrollX - 
      ampClientScrollY - 
      ampClientMaxScrollX - 
      ampClientMaxScrollY - 
      ampTotalEngagedTime - 
      ampPageViewId - 
      ampPageLoadTime - 
      ampPageDownloadTime - 
      ampGtmEvent - 
      eventName - 
      firebaseEventParameterCampaign - 
      firebaseEventParameterCampaignAclid - 
      firebaseEventParameterCampaignAnid - 
      firebaseEventParameterCampaignClickTimestamp - 
      firebaseEventParameterCampaignContent - 
      firebaseEventParameterCampaignCp1 - 
      firebaseEventParameterCampaignGclid - 
      firebaseEventParameterCampaignSource - 
      firebaseEventParameterCampaignTerm - 
      firebaseEventParameterCurrency - 
      firebaseEventParameterDynamicLinkAcceptTime - 
      firebaseEventParameterDynamicLinkLinkid - 
      firebaseEventParameterNotificationMessageDeviceTime - 
      firebaseEventParameterNotificationMessageId - 
      firebaseEventParameterNotificationMessageName - 
      firebaseEventParameterNotificationMessageTime - 
      firebaseEventParameterNotificationTopic - 
      firebaseEventParameterPreviousAppVersion - 
      firebaseEventParameterPreviousOsVersion - 
      firebaseEventParameterPrice - 
      firebaseEventParameterProductId - 
      firebaseEventParameterQuantity - 
      firebaseEventParameterValue - 
      videoProvider - 
      videoUrl - 
      videoTitle - 
      videoDuration - 
      videoPercent - 
      videoVisible - 
      videoStatus - 
      videoCurrentTime - 
      scrollDepthThreshold - 
      scrollDepthUnits - 
      scrollDepthDirection - 
      elementVisibilityRatio - 
      elementVisibilityTime - 
      elementVisibilityFirstTime - 
      elementVisibilityRecentTime - 
      requestPath - 
      requestMethod - 
      clientName - 
      queryString - 
      serverPageLocationUrl - 
      serverPageLocationPath - 
      serverPageLocationHostname - 
      visitorRegion - 
      analyticsClientId - 
      analyticsSessionId - 
      analyticsSessionNumber - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The result of reverting a built-in variable in a workspace.
  &quot;enabled&quot;: True or False, # Whether the built-in variable is enabled after reversion.
}</pre>
</div>

</body></html>